home *** CD-ROM | disk | FTP | other *** search
TTTToooooooollllssss((((3333CCCC++++++++)))) TTTToooooooollllssss((((3333CCCC++++++++)))) NNNNaaaammmmeeee librwtool - Rogue Wave library class introduction IIIInnnnttttrrrroooodddduuuuccccttttiiiioooonnnn The TTTToooooooollllssss....hhhh++++++++ CCCCllllaaaassssssss RRRReeeeffffeeeerrrreeeennnncccceeee describes all the classes and functions in TTTToooooooollllssss....hhhh++++++++. It does nnnnooootttt provide a tutorial on how to program with the TTTToooooooollllssss....hhhh++++++++ class library. For information on how to write programs using TTTToooooooollllssss....hhhh++++++++, consult the TTTToooooooollllssss....hhhh++++++++ UUUUsssseeeerrrr''''ssss GGGGuuuuiiiiddddeeee. For information on installing and using TTTToooooooollllssss....hhhh++++++++, review the TTTToooooooollllssss....hhhh++++++++ GGGGeeeettttttttiiiinnnngggg SSSSttttaaaarrrrtttteeeedddd GGGGuuuuiiiiddddeeee. OOOOrrrrggggaaaannnniiiizzzzaaaattttiiiioooonnnn ooooffff tttthhhheeee CCCCllllaaaassssssss RRRReeeeffffeeeerrrreeeennnncccceeee Immediately following this introduction is a class hierarchy diagram. The class hierarchy lists all the classes, and illustrates the relationships among them. You can refer to it for a bird's-eye view of the inheritance structure used in TTTToooooooollllssss....hhhh++++++++. The remainder of this reference is an alphabetical listing of classes. The entry for each class begins with an illustration showing the individual class's inheritance hierarchy, followed by a synopsis that lists the header files(s) and the Smalltalk typedef (if appropriate) associated with the class. The synopsis also shows a declaration and definition of a class object, and any typedefs that are used. Following the synopsis is a brief description of the class, and a list of member and global functions. These functions are organized in categories according to their general use - for example, "constructors," "global operators," and "public member functions." The categories, although somewhat arbitrary, provide a way of organizing the many functions. CCCCoooonnnnvvvveeeennnnttttiiiioooonnnnssss All Rogue Wave class names start with the letters RRRRWWWW, as in RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee, with the bold font emphasizing the class name rather than the prefix. In some cases, we may refer to an instance of a class by an English name; for example, "the string" instead of "the RRRRWWWWCCCCSSSSttttrrrriiiinnnngggg instance." We do this to make it easier to read when the meaning should be clear from context, but we use the longer form if there is a possible ambiguity. All function names begin with a lower case letter, with the first letter of subsequent words capitalized. Function names attempt to accurately describe what a function does. For example, RRRRWWWWCCCCSSSSttttrrrriiiinnnngggg::::::::ttttooooLLLLoooowwwweeeerrrr(((()))) changes all uppercase letters in itself to lowercase. Underline characters and abbreviations are not generally used in function names. Function names, examples, operating system commands, mathematical symbols and code fragments are shown in a courier font, as in <<<<rrrrwwww////ssssttttrrrreeeeaaaammmm....hhhh>>>> . Vertical ellipses are used in code examples to indicate that some part of the code is missing. Throughout this documentation, there are frequent references to "self." This should be read as "****tttthhhhiiiissss". IIIInnnnhhhheeeerrrriiiittttaaaannnncccceeee NNNNoooottttaaaattttiiiioooonnnn Each class that inherits from another class (or other classes) includes an illustration that shows the inheritance hierarchy. For example, the following illustration indicates that class AAAA inherits from class BBBB: When a class inherits from more than one class, or there are multiple PPPPaaaaggggeeee 1111 TTTToooooooollllssss((((3333CCCC++++++++)))) TTTToooooooollllssss((((3333CCCC++++++++)))) levels of inheritance, all of the inheritance relationships are shown. For example, the following illustration indicates that AAAA inherits from class BBBB and from class CCCC, which inherits from class DDDD. The notation system used in the inheritance hierarchies is based on the Object Modeling Technique (OMT) developed by Rumbaugh and others. MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss Within their general categories, member functions for each class are listed alphabetically. Member functions fall into three general types: Functions that are uuuunnnniiiiqqqquuuueeee to a class. The complete documentation for these functions is presented in the class where they occur. An example is bbbbaaaallllaaaannnncccceeee(((()))), a member of the class RRRRWWWWBBBBiiiinnnnaaaarrrryyyyTTTTrrrreeeeeeee. Functions that are iiiinnnnhhhheeeerrrriiiitttteeeedddd from a base class without being redefined. The complete documentation for these functions is presented in the defining bbbbaaaasssseeee ccccllllaaaassssssss. An example is cccclllleeeeaaaarrrrAAAAnnnnddddDDDDeeeessssttttrrrrooooyyyy(((()))), for class RRRRWWWWBBBBiiiinnnnaaaarrrryyyyTTTTrrrreeeeeeee, which is inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn. When a member function is inherited without being redefined, the member function appears in both places, and this guide refers you to the original definition. Functions that are rrrreeeeddddeeeeffffiiiinnnneeeedddd in a derived class. These are usually virtual functions. The documentation for these functions usually directs you to the base class, but may also mention peculiarities that are relevant to the derived class. An example is aaaappppppppllllyyyy(((()))),,,, for class RRRRWWWWBBBBiiiinnnnaaaarrrryyyyTTTTrrrreeeeeeee. CCCCllllaaaassssssss HHHHiiiieeeerrrraaaarrrrcccchhhhyyyy The following list shows the public class hierarchy of the TTTToooooooollllssss....hhhh++++++++ classes. Note that this is the ppppuuuubbbblllliiiicccc class hierarchy--the implementation of a given class may use private inheritance. Additionally, some classes inherit from public, but undocumented, implementation classes. Undocumented classes are omitted from the hierarchy. Classes derived by multiple inheritance show their additional base(s) in italics to the right of the class name. CCCCllllaaaassssssss HHHHiiiieeeerrrraaaarrrrcccchhhhyyyy RRRRWWWWBBBBeeeennnncccchhhh RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn RRRRWWWWBBBBaaaagggg RRRRWWWWBBBBiiiinnnnaaaarrrryyyyTTTTrrrreeeeeeee RRRRWWWWBBBBTTTTrrrreeeeeeee RRRRWWWWBBBBTTTTrrrreeeeeeeeDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeee RRRRWWWWSSSSeeeetttt RRRRWWWWFFFFaaaaccccttttoooorrrryyyy RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy RRRRWWWWIIIIddddeeeennnnttttiiiittttyyyyDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy RRRRWWWWIIIIddddeeeennnnttttiiiittttyyyySSSSeeeetttt RRRRWWWWSSSSeeeeqqqquuuueeeennnncccceeeeaaaabbbblllleeee RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss PPPPaaaaggggeeee 2222 TTTToooooooollllssss((((3333CCCC++++++++)))) TTTToooooooollllssss((((3333CCCC++++++++)))) RRRRWWWWOOOOrrrrddddeeeerrrreeeedddd RRRRWWWWSSSSoooorrrrtttteeeeddddVVVVeeeeccccttttoooorrrr RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssSSSSttttaaaacccckkkk RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeAAAAssssssssoooocccciiiiaaaattttiiiioooonnnn RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeDDDDaaaatttteeee ((((&&&&RRRRWWWWDDDDaaaatttteeee)))) RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeIIIInnnntttt (&&&&RRRRWWWWIIIInnnntttteeeeggggeeeerrrr)))) RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeSSSSttttrrrriiiinnnngggg ((((&&&&RRRRWWWWCCCCSSSSttttrrrriiiinnnngggg)))) RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeTTTTiiiimmmmeeee ((((&&&&RRRRWWWWTTTTiiiimmmmeeee)))) RRRRWWWWMMMMooooddddeeeellllCCCClllliiiieeeennnntttt RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeSSSSttttrrrriiiinnnngggg ((((&&&&RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee)))) RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeDDDDaaaatttteeee ((((&&&&RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee)))) RRRRWWWWEEEErrrrrrrrOOOObbbbjjjjeeeecccctttt RRRRWWWWFFFFiiiilllleeeeMMMMaaaannnnaaaaggggeeeerrrr RRRRWWWWGGGGSSSSoooorrrrtttteeeeddddVVVVeeeeccccttttoooorrrr((((vvvvaaaallll)))) RRRRWWWWIIIInnnnssssttttaaaannnncccceeeeMMMMaaaannnnaaaaggggeeeerrrr RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeIIIInnnntttt (&&&&RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee)))) RRRRWWWWBBBBaaaaggggIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWBBBBiiiinnnnaaaarrrryyyyTTTTrrrreeeeeeeeIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWDDDDlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWHHHHaaaasssshhhhDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWSSSSeeeettttIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWOOOOrrrrddddeeeerrrreeeeddddIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssIIIItttteeeerrrraaaattttoooorrrr RRRRWWWWLLLLooooccccaaaalllleeeeSSSSnnnnaaaappppsssshhhhooootttt RRRRWWWWMMMMeeeessssssssaaaaggggeeee RRRRWWWWRRRReeeeffffeeeerrrreeeennnncccceeee RRRRWWWWCCCCSSSSttttrrrriiiinnnnggggRRRReeeeffff RRRRWWWWVVVViiiirrrrttttuuuuaaaallllRRRReeeeffff RRRRWWWWWWWWSSSSttttrrrriiiinnnnggggRRRReeeeffff RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeeeTTTTiiiimmmmeeee ((((&&&&RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee)))) RRRRWWWWTTTTPPPPttttrrrrSSSSlllliiiissssttttDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy<<<<KKKKeeeeyyyyPPPP,,,,VVVVaaaallllPPPP>>>> RRRRWWWWTTTTPPPPttttrrrrSSSSlllliiiissssttttDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr<<<<KKKKeeeeyyyyPPPP,,,,VVVVaaaallllPPPP>>>> RRRRWWWWTTTTRRRReeeegggguuuullllaaaarrrrEEEExxxxpppprrrreeeessssssssiiiioooonnnn<<<<cccchhhhaaaarrrrTTTT>>>> RRRRWWWWTTTTVVVVaaaallllSSSSlllliiiissssttttDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyy<<<<KKKKeeeeyyyy,,,,VVVV>>>> RRRRWWWWTTTTVVVVaaaallllSSSSlllliiiissssttttDDDDiiiiccccttttiiiioooonnnnaaaarrrryyyyIIIItttteeeerrrraaaattttoooorrrr<<<<KKKKeeeeyyyy,,,,VVVV>>>> iiiioooossss (virtual) RRRRWWWWvvvviiiissssttttrrrreeeeaaaammmm RRRRWWWWbbbbiiiissssttttrrrreeeeaaaammmm ((((&&&&iiiioooossss:::: virtual)))) RRRRWWWWeeeeiiiissssttttrrrreeeeaaaammmm RRRRWWWWppppiiiissssttttrrrreeeeaaaammmm RRRRWWWWXXXXDDDDRRRRiiiissssttttrrrreeeeaaaammmm ((((&&&&RRRRWWWWiiiioooossss)))) RRRRWWWWvvvvoooossssttttrrrreeeeaaaammmm RRRRWWWWbbbboooossssttttrrrreeeeaaaammmm ((((&&&&iiiioooossss:::: virtual)))) RRRRWWWWeeeeoooossssttttrrrreeeeaaaammmm RRRRWWWWppppoooossssttttrrrreeeeaaaammmm RRRRWWWWXXXXDDDDRRRRoooossssttttrrrreeeeaaaammmm ((((&&&&RRRRWWWWiiiioooossss)))) RRRRWWWWBBBBuuuuffffffffeeeerrrreeeeddddPPPPaaaaggggeeeeHHHHeeeeaaaapppp RRRRWWWWDDDDiiiisssskkkkPPPPaaaaggggeeeeHHHHeeeeaaaapppp RRRRWWWWZZZZoooonnnneeeeSSSSiiiimmmmpppplllleeee PPPPaaaaggggeeee 3333 TTTToooooooollllssss((((3333CCCC++++++++)))) TTTToooooooollllssss((((3333CCCC++++++++)))) ssssttttrrrreeeeaaaammmmbbbbuuuuffff RRRRWWWWAAAAuuuuddddiiiittttSSSSttttrrrreeeeaaaammmmBBBBuuuuffffffffeeeerrrr RRRRWWWWCCCCLLLLIIIIPPPPssssttttrrrreeeeaaaammmmbbbbuuuuffff RRRRWWWWDDDDDDDDEEEEssssttttrrrreeeeaaaammmmbbbbuuuuffff xxxxmmmmssssgggg RRRRWWWWxxxxmmmmssssgggg RRRRWWWWEEEExxxxtttteeeerrrrnnnnaaaallllEEEErrrrrrrr RRRRWWWWFFFFiiiilllleeeeEEEErrrrrrrr RRRRWWWWSSSSttttrrrreeeeaaaammmmEEEErrrrrrrr RRRRWWWWIIIInnnntttteeeerrrrnnnnaaaallllEEEErrrrrrrr RRRRWWWWBBBBoooouuuunnnnddddssssEEEErrrrrrrr RRRRWWWWxxxxaaaalllllllloooocccc CCCCoooonnnntttteeeennnnttttssss PPPPaaaaggggeeee 4444 
